This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/daf-medicationlist
US Realm Medication list
This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from List.
Summary
Mandatory: 4 elements (+1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
This structure is derived from List.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | List | US Realm Medication list | |
identifier | S | 0..* | Identifier | |
code | S | 1..1 | CodeableConcept | Binding: DAF Medication List Codes (required) |
subject | S | 0..1 | Reference(DAF-Patient) | |
source | S | 1..1 | Reference(U.S. Data Access Framework (DAF) Practitioner Profile | DAF-Patient | Device) | |
date | S | 1..1 | dateTime | |
mode | S | 1..1 | code | Fixed Value: snapshot |
entry | S | 0..* | BackboneElement | |
flag | S | 0..1 | CodeableConcept | |
deleted | 0..0 | |||
date | S | 0..1 | dateTime | |
item | S | 1..1 | Reference(U.S. Data Access Framework (DAF) MedicationStatement Profile | U.S. Data Access Framework (DAF) Medication Administration Profile | U.S. Data Access Framework (DAF) MedicationOrder Profile | U.S. Data Access Framework (DAF) MedicationDispense Profile) | |
emptyReason | S | 0..1 | CodeableConcept | Binding: List Empty Reasons (extensible) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | US Realm Medication list lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-1: A list can only have an emptyReason if it is empty |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Business identifier |
title | ∑ | 0..1 | string | Descriptive name for the list Example: Dr. Jane's Patients |
code | S ∑ | 1..1 | CodeableConcept | What the purpose of this list is Binding: DAF Medication List Codes (required) |
subject | S ∑ | 0..1 | Reference(DAF-Patient) | If all resources have the same subject |
source | S ∑ | 1..1 | Reference(U.S. Data Access Framework (DAF) Practitioner Profile | DAF-Patient | Device) | Who and/or what defined the list contents (aka Author) |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
status | ?! ∑ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
date | S ∑ | 1..1 | dateTime | When the list was prepared |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
mode | ?! S∑ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) Fixed Value: snapshot |
note | 0..1 | string | Comments about the list | |
entry | S I | 0..* | BackboneElement | Entries in the list |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
flag | S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) |
date | S | 0..1 | dateTime | When item added to list |
item | S | 1..1 | Reference(U.S. Data Access Framework (DAF) MedicationStatement Profile | U.S. Data Access Framework (DAF) Medication Administration Profile | U.S. Data Access Framework (DAF) MedicationOrder Profile | U.S. Data Access Framework (DAF) MedicationDispense Profile) | Actual entry |
emptyReason | S I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (extensible) |
Documentation for this format |
todo
This structure is derived from List.
Summary
Mandatory: 4 elements (+1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from List.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | List | US Realm Medication list | |
identifier | S | 0..* | Identifier | |
code | S | 1..1 | CodeableConcept | Binding: DAF Medication List Codes (required) |
subject | S | 0..1 | Reference(DAF-Patient) | |
source | S | 1..1 | Reference(U.S. Data Access Framework (DAF) Practitioner Profile | DAF-Patient | Device) | |
date | S | 1..1 | dateTime | |
mode | S | 1..1 | code | Fixed Value: snapshot |
entry | S | 0..* | BackboneElement | |
flag | S | 0..1 | CodeableConcept | |
deleted | 0..0 | |||
date | S | 0..1 | dateTime | |
item | S | 1..1 | Reference(U.S. Data Access Framework (DAF) MedicationStatement Profile | U.S. Data Access Framework (DAF) Medication Administration Profile | U.S. Data Access Framework (DAF) MedicationOrder Profile | U.S. Data Access Framework (DAF) MedicationDispense Profile) | |
emptyReason | S | 0..1 | CodeableConcept | Binding: List Empty Reasons (extensible) |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | US Realm Medication list lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-1: A list can only have an emptyReason if it is empty |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | Business identifier |
title | ∑ | 0..1 | string | Descriptive name for the list Example: Dr. Jane's Patients |
code | S ∑ | 1..1 | CodeableConcept | What the purpose of this list is Binding: DAF Medication List Codes (required) |
subject | S ∑ | 0..1 | Reference(DAF-Patient) | If all resources have the same subject |
source | S ∑ | 1..1 | Reference(U.S. Data Access Framework (DAF) Practitioner Profile | DAF-Patient | Device) | Who and/or what defined the list contents (aka Author) |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
status | ?! ∑ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
date | S ∑ | 1..1 | dateTime | When the list was prepared |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
mode | ?! S∑ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) Fixed Value: snapshot |
note | 0..1 | string | Comments about the list | |
entry | S I | 0..* | BackboneElement | Entries in the list |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
flag | S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) |
date | S | 0..1 | dateTime | When item added to list |
item | S | 1..1 | Reference(U.S. Data Access Framework (DAF) MedicationStatement Profile | U.S. Data Access Framework (DAF) Medication Administration Profile | U.S. Data Access Framework (DAF) MedicationOrder Profile | U.S. Data Access Framework (DAF) MedicationDispense Profile) | Actual entry |
emptyReason | S I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (extensible) |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
List.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
List.code | DAF Medication List Codes | required | DAF Medication List Codes |
List.status | ListStatus | required | ListStatus |
List.orderedBy | List Order Codes | preferred | List Order Codes |
List.mode | ListMode | required | ListMode |
List.entry.flag | Patient Medicine Change Types | example | Patient Medicine Change Types |
List.emptyReason | List Empty Reasons | extensible | List Empty Reasons |
Id | Path | Details | Requirements |
lst-2 | List | The deleted flag can only be used if the mode of the list is "changes" XPath: (f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted)) | |
lst-1 | List | A list can only have an emptyReason if it is empty XPath: not(exists(f:emptyReason) and exists(f:entry)) |